dundas.Utility Class

Properties

Methods

	Name	Description
	addAutoColorRuleProperties	Adds property descriptors for an automatic color binding rule and applies the value when set.
	addAutoRuleProperties	Adds property descriptors for an automatic data binding rule and applies the value when set.
	addAutoSizeRuleProperties	Adds property descriptors for an automatic size binding rule and applies the value when set.
	addColorScaleProperties	Adds property descriptors for color scale settings for an applicable color binding rule, and applies the values when set.
	addDataControlBorderProperties	Adds property descriptors for the border properties of a DataControl to the specified object descriptor.
	addDiscreteColorRuleProperties	Adds property descriptors for a discrete color binding rule and applies the value when set.
	addDiscreteRuleProperties	Adds property descriptors for a discrete data binding rule and applies the value when set.
	addDiscreteSizeRuleProperties	Adds property descriptors for a discrete size binding rule and applies the value when set.
	addRangeColorRuleProperties	Adds property descriptors for a range color binding rule and applies the value when set.
	addRangeRuleProperties	Adds property descriptors for a range data binding rule and applies the value when set.
	addRangeSizeRuleProperties	Adds property descriptors for a range size binding rule and applies the value when set.
	applyParameterValuesToInputValues	Looks at an input form, and applies the given parameter values to the form.
	asType	Returns a value determined to be the specified type.
	bindDoubleTapClickEvent	Add a doubleclick event to the target, if device is touch-enabled, also add handler to doubletap event.
	bindHoldContextMenuEvent	Add a context menu event to the target, if device is touch-enabled, also add handler to hold event.
	bindTapClickEvent	Add a click event to the target, if device is touch-enabled, also add handler to tap event.
	bindTapHoldEvent	Add a click hold event to the target, if device is touch-enabled, also add handler to tap event.
	bindTapReleaseEvent	Add a click end to the target, if device is touch-enabled, also add handler to tap event.
	bindTapTouchEvent	Add a click start event to the target, if device is touch-enabled, also add handler to tap event.
	checkIsAdjacent	Check if 2 boundary are adjacent to each other.
	checkSingleType	Check to see if all objects in objectList are of the same type
	cleanseText	Given some text, will cleanse it for '<' and '>' characters by encoding it to HTML.
	cloneData	Clones a storable string representing the data
	convertAbsoluteToRelativeBound	Convert absolute bound to relative bound
	convertAbsoluteToRelativePosition	Convert absolute to relative position.
	convertArgumentsToArray	The "arguments" special keywords looks like an array, but it isn't. This method converts it to an array.
	convertRelativeToAbsolutePosition	Convert relative to absolute position.
	convertTitleToTooltip	Converts title attributes to app style tooltips.
	createDelegate	Helper for creating delegate functions.
	createGuid	Create a GUID like UUID. UUID does not base its information on some of the requirements in GUID (i.e. hardware/browser/version). But it should be unique enough.
	createSVGElement	Helper for creating SVG DOM element.
	delayExecute	Delay an execute of a function by some time. if the same identifier is used, previous calls will be cancelled.
	distance	Find the distance between 2 rectangles.
	encodeXML	Given some text, will encode XML characters to be displayed as regular text in HTML.
	generateDiscreteColorRules	Generates and adds discrete color rules to the specified collection for the first hierarchy assigned as color.
	generateLabelText	Gets label text generated by a set of label bindings pointing to elements from a metric set.
	generateNextNames	Generates the next name and friendly name to be used for some item. For example, if "adapter" prefix and a dashboard search object is given, "adapter 1", "adapter1" may be returned.
	generateNextViewNames	Generates the next name and friendly name to be used for some item. For example, if "adapter" prefix and a view search object is given, "adapter 1", "adapter1" may be returned.
	generateNumberRange	Generate a range of numbers.
	generateTooltipText	Gets tooltip text generated by a set of tooltip bindings pointing to elements from a metric set.
	getAbsoluteCoordOfRelativeCoord	Convert relative coordinates to absolute coordinates.
	getAdapterBoundingClientRect	Gets the bounding client rectangle of an adapter.
	getAdapterHitTestArguments	Produces an object with consistent event argument information for data control hit testing.
	getAllInputValuesForParameterValue	Creates an object that represents all the input items and their values from all input elements under the given element ID. This is designed to work with ParameterValue fields from PropertyDescriptors.
	getBrushingParameterMembers	Gets members specified in a parameter value for the purpose of matching other members when data brushing.
	getColorRuleItemTypes	Determines which color rule types should be provided as options for the current data and returns corresponding objects compatible with CollectionPropertyDescriptor.
	getContextualPageUrl	Given a page and additional options, creates a URL that is contextual. For example '/vdir/Dashboard/id?key1=value1'.
	getContextualUrlPath	Given a URL, returns an app contextual URL path. Don't prefix the URL with a leading /.
	getCorrectCssDimensionValue	Gets the correct CSS dimension value.
	getCurrentFullContextualUrlPath	Given a URL, returns a full URL string based on the current URL. For example, given 'dashboard/{id}', 'http:test.com:20/vdir/dashboard/{id}' may be returned.
	getCurrentFullUrlAddress	Gets the current full URL address (without virtual directory). For example, 'http:test.com:20'.
	getElementCaptionVisualizationText	Gets text that can be used as a placeholder keyword in a visualization referring to a metric set element usage by its caption.
	getFullContextualPageUrl	Given a page and additional options, creates a full URL. For example 'http:test.com:20/vdir/Dashboard/id?key1=value1'.
	getHitTestArguments	Produces an object with consistent event argument information for data control hit testing.
	getLastModifiedParameterValuesById	Gets an object with parameter IDs as properties and the last-modified parameter values as values.
	getMemberAtLevel	Returns the member or one of its parent members at the specified level.
	getMemberAtLevelDepth	Returns the member or one of its parent members at the specified level.
	getMemberLevelCaption	Gets the caption of a member's level, or hierarchy if not applicable.
	getMetricSetPlacementsByUniqueName	Gets an object with the metric set's element usage unique names as properties and location information as values.
	getNested	Gets a value stored in the specified object using the specified keys as property names that can be accessed successively within nested objects.
	getObjectTypePage	Returns page associated with object type.
	getOverallScale	Gets the scale including all parent canvas scaling for a given canvas, in cases where it is a subcanvas.
	getOverallScaleXY	Gets the scale including all parent canvas scaling for a given canvas, in cases where it is a subcanvas.
	getParameterValuesFromInputValues	Looks at an input form, uses getAllInputValuesForParameterValue(selector), and then parses that to create dundas.data.ParameterValue objects for each value.
	getPrototypeFromClasstype
	getScaledTooltipBounds	Gets an object describing the rectangular bounds to use for positioning a tooltip based on the specified unscaled relative bounds.
	getSizeRuleItemTypes	Determines which size rule types should be provided as options for the current data and returns corresponding objects compatible with CollectionPropertyDescriptor.
	getSortedMetricSetUsages	Gets an array with the specified objects representing a metric set's displayed analysis element usages sorted by index and grouped by placement in the order: rows, columns, and measures.
	getStorableData	Creates a storable string representing the data
	getStorableDataType	Retrieves the type of data for storage data.
	getUTCOffsetDateTime	Alters the specified date to handle offsetting by the browser between UTC and the local time zone when parsing and stringifying.
	getViewTemplate
	helpIndicate	Applies a zoom animation to the target element so that it stands out as a visual feedback.
	info	Outputs the specified string with any specified parameters (using string.format() methodology) to the console (console.info).
	isGuid	Checks if the given string is a GUID like UUID.
	isTouchEnabled	Determine whether the browser is supposed to use touch events or not.
	localizeList	Gets a string containing a localized enumeration of an array of items, optionally started by an array of preceding items and a colon.
	log	Outputs the specified string with any specified parameters (using string.format() methodology) to the console (console.log).
	objectFromString	Finds the object from the given string. For example, if "dundas.data.ParameterValue" is given, window[dundas][data][ParameterValue] will be returned.
	onColorRulePropertyChanged	Provides default colors for new color rules when their collection property is changed to add new items.
	pointsDistance	Find the distance between 2 points.
	preventGenerateNameCache	Override generateNextViewNames function so that its next call doesn't no use the cache at all cost.
	profileEnd	Ends a profile.
	profileStart	Starts a profile.
	queueExecute	Delay an execution of a function by some time. If the same identifier is used, function call will be placed in a queue, and executed synchronously when delay is up.
	regexpEncode	Encodes regular expression special characters in a string so that its exact value will be matched in a regular expression.
	restoreStorableData	Restore a storable string to the actual data
	setAutoResetFlag	Sets a timer to automatically reset a flag after a delay.
	setNested	Sets a value in the specified object using the specified keys as property names accessed successively within nested objects.
	setOptions	Sets copies property values from an options object onto another object.
	setParallelSlicerKeywordMappings	Sets up keyword mappings on the specified object for the parallel slicer measure information provided, if applicable.
	setupMetricSetKeywordProperty	Sets up a string property descriptor to include all available metric set elements as options for inserting keywords into the text.
	stopExecute	Prevent a function queued by delayExecute to execute.
	unbindDoubleTapClickEvent	Remove a doubleclick event to the target, if device is touch-enabled, also remove handler to doubletap event.
	unbindHoldContextMenuEvent	Remove a context menu event to the target, if device is touch-enabled, also remove handler to hold event.
	unbindTapClickEvent	Remove a click event to the target, if device is touch-enabled, also remove handler to tap event.
	unbindTapHoldEvent	Remove a click hold event from the target, if device is touch-enabled, also remove handler to tap event.
	unbindTapReleaseEvent	Remove a click end event from the target, if device is touch-enabled, also remove handler to tap event.
	unbindTapTouchEvent	Remove a click start event from the target, if device is touch-enabled, also remove handler to tap event.
	waitForFrames
	warn	Outputs the specified string with any specified parameters (using string.format() methodology) to the console (console.warn).
	wrapTextComponents	Wraps every word (or piece) of a text-based String with a tag. Used to add support for ellipsis on overflow text.
	wrapTextComponentsRecursive	Recursively split content by characters in split list and wrap each part with a 'span' tag. Used to add support for ellipsis on overflow text.